Skip to content

[CF1] tunnel run flag note #20781

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 5 commits into from
Mar 21, 2025
Merged

[CF1] tunnel run flag note #20781

merged 5 commits into from
Mar 21, 2025

Conversation

@deadlypants1973
Copy link
Contributor

@deadlypants1973 deadlypants1973 commented Mar 13, 2025

Summary

13940

Documentation checklist

  • The documentation style guide has been adhered to.
  • If a larger change - such as adding a new page- an issue has been opened in relation to any incorrect or out of date information that this PR fixes.
  • Files which have changed name or location have been allocated redirects.

@deadlypants1973 deadlypants1973 requested review from a team and ranbel as code owners March 13, 2025 13:53
@hyperlint-ai
Copy link
Contributor

hyperlint-ai bot commented Mar 13, 2025

Howdy and thanks for contributing to our repo. The Cloudflare team reviews new, external PRs within two (2) weeks. If it's been two weeks or longer without any movement, please tag the PR Assignees in a comment.

We review internal PRs within 1 week. If it's something urgent or has been sitting without a comment, start a thread in the Developer Docs space internally.

PR Change Summary

Updated documentation for tunnel run parameters and clarified the creation of remotely-managed tunnels.

  • Modified the tunnel run parameters documentation to include a note for locally-managed and remotely-managed tunnels.
  • Clarified the language in the guide for creating a remotely-managed tunnel using Zero Trust.

Modified Files

  • src/content/docs/cloudflare-one/connections/connect-networks/configure-tunnels/cloudflared-parameters/run-parameters.mdx
  • src/content/docs/cloudflare-one/connections/connect-networks/get-started/create-remote-tunnel.mdx
How can I customize these reviews?

Check out the Hyperlint AI Reviewer docs for more information on how to customize the review.

If you just want to ignore it on this PR, you can add the hyperlint-ignore label to the PR. Future changes won't trigger a Hyperlint review.

Note specifically for link checks, we only check the first 30 links in a file and we cache the results for several hours (for instance, if you just added a page, you might experience this). Our recommendation is to add hyperlint-ignore to the PR to ignore the link check for this PR.

What is Hyperlint?

Hyperlint is an AI agent that helps you write, edit, and maintain your documentation.

Learn more about the Hyperlint AI reviewer and the checks that we can run on your documentation.

@github-actions github-actions bot added size/m and removed size/s labels Mar 13, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Mar 13, 2025 •
edited
Loading

Preview URL: https://d285e31a.preview.developers.cloudflare.com
Preview Branch URL: https://kate-fixes-pxc13940.preview.developers.cloudflare.com

Files with changes (up to 15)

Original Link Updated Link
https://developers.cloudflare.com/cloudflare-one/connections/connect-networks/get-started/create-remote-tunnel-api/ https://kate-fixes-pxc13940.preview.developers.cloudflare.com/cloudflare-one/connections/connect-networks/get-started/create-remote-tunnel-api/
https://developers.cloudflare.com/cloudflare-one/connections/connect-networks/configure-tunnels/cloudflared-parameters/run-parameters/ https://kate-fixes-pxc13940.preview.developers.cloudflare.com/cloudflare-one/connections/connect-networks/configure-tunnels/cloudflared-parameters/run-parameters/
https://developers.cloudflare.com/cloudflare-one/connections/connect-networks/downloads/update-cloudflared/ https://kate-fixes-pxc13940.preview.developers.cloudflare.com/cloudflare-one/connections/connect-networks/downloads/update-cloudflared/
https://developers.cloudflare.com/cloudflare-one/connections/connect-networks/get-started/create-remote-tunnel/ https://kate-fixes-pxc13940.preview.developers.cloudflare.com/cloudflare-one/connections/connect-networks/get-started/create-remote-tunnel/

ranbel
ranbel reviewed Mar 14, 2025
View reviewed changes
...one/connections/connect-networks/configure-tunnels/cloudflared-parameters/run-parameters.mdx Outdated

:::note

For locally-managed tunnels and Windows [remotely-managed tunnels](/cloudflare-one/connections/connect-networks/get-started/tunnel-useful-terms/#remotely-managed-tunnel) only.
Copy link
Contributor

@ranbel ranbel Mar 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd frame this in terms of package manager vs no package manager. Technically no-autoupdate would also work for non-Windows tunnels if you didn't use a package manager.

Does not apply if you installed cloudflared using a package manager (for example, by following the macOS or Debian installation instructions in the dashboard). You can check if cloudflared was installed by a package manager by running ls -la /usr/local/etc/cloudflared/ and looking for .installedFromPackageManager appears in the output. If so, disable auto-update in the package manager.

Consider making a partial out of the matching sentence in https://developers.cloudflare.com/cloudflare-one/connections/connect-networks/downloads/update-cloudflared/#remotely-managed-tunnels

@deadlypants1973 deadlypants1973 merged commit c521ee4 into production Mar 21, 2025
11 checks passed
@deadlypants1973 deadlypants1973 deleted the kate/fixes-pxc13940 branch March 21, 2025 21:13
RebeccaTamachiro pushed a commit that referenced this pull request Apr 21, 2025
@deadlypants1973 @RebeccaTamachiro
[CF1] tunnel run flag note (#20781)
b8d84aa 
* [CF1] tunnel run flag note

* update step 2

* link

* error

* partial
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ranbel ranbel ranbel approved these changes

Assignees

@ranbel ranbel

Labels

product:cloudflare-one size/m

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@deadlypants1973 @ranbel